Skip to content

Conversation

jonemo
Copy link
Contributor

@jonemo jonemo commented Oct 24, 2021

Issue #, if available: N/A

Description of changes:

The SAM snippets in the "Install" section on the homepage were invalid due to incorrect indentation. When copy-and-pasted into a SAM template, sam build would yield lengthy stack traces and with errors such as

samtranslator.model.exceptions.InvalidDocumentException: [InvalidResourceException('AwsLambdaPowertoolsPythonLayer', 'Resource is missing the required [Location] property.')]

This PR fixes the instances of incorrect indentation.

For reference, the relevant section of the SAM syntax docs is here.

Checklist

Breaking change checklist

N/A: Not a breaking change.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.


View rendered docs/index.md

@pull-request-size pull-request-size bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Oct 24, 2021
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Oct 24, 2021
@boring-cyborg
Copy link

boring-cyborg bot commented Oct 24, 2021

Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need.

@heitorlessa
Copy link
Contributor

Thanks a lot @jonemo

@heitorlessa heitorlessa merged commit 4c41ec5 into aws-powertools:develop Oct 25, 2021
@boring-cyborg
Copy link

boring-cyborg bot commented Oct 25, 2021

Awesome work, congrats on your first merged pull request and thank you for helping improve everyone's experience!

heitorlessa added a commit to gyft/aws-lambda-powertools-python that referenced this pull request Oct 29, 2021
…uter

* michaelbrewer/docs/router:
  feat(data-classes): ActiveMQ and RabbitMQ support (aws-powertools#770)
  feat(appsync): add Router to allow large resolver composition (aws-powertools#776)
  chore(deps-dev): bump mkdocs-material from 7.3.3 to 7.3.5 (aws-powertools#781)
  chore(deps-dev): bump flake8-isort from 4.0.0 to 4.1.1 (aws-powertools#785)
  chore(deps): bump urllib3 from 1.26.4 to 1.26.5 (aws-powertools#787)
  chore(deps-dev): bump flake8-eradicate from 1.1.0 to 1.2.0 (aws-powertools#784)
  chore(deps): bump boto3 from 1.18.61 to 1.19.6 (aws-powertools#783)
  chore(deps-dev): bump pytest-asyncio from 0.15.1 to 0.16.0 (aws-powertools#782)
  docs: fix indentation of SAM snippets in install section (aws-powertools#778)
  Fix middleware sample (aws-powertools#772)
  Removed unused import, added typing imports, fixed typo in example. (aws-powertools#774)
  Fix middleware sample (aws-powertools#772)
  Removed unused import, added typing imports, fixed typo in example. (aws-powertools#774)
  Update docs/core/event_handler/api_gateway.md

# Conflicts:
#	docs/core/event_handler/api_gateway.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants